home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / kernel / lfs / lfsSuperBlock.h < prev    next >
Encoding:
C/C++ Source or Header  |  1992-12-19  |  4.9 KB  |  125 lines
  1. /*
  2.  * lfsSuperBlock.h --
  3.  *
  4.  *    Declarations defining the disk resident format of the LFS 
  5.  *    super block. The main purpose of the super block is to allow
  6.  *    the file system to be recovered and reattached upon file server
  7.  *    reboot. The super block is divided into two section the static
  8.  *    super block and the checkpoint area.  The super block
  9.  *    contains the nonchangable parameters that describe the LFS. 
  10.  *    The checkpoint area contains the parameters that change when the
  11.  *    file system is modified.
  12.  *
  13.  * Copyright 1989 Regents of the University of California
  14.  * Permission to use, copy, modify, and distribute this
  15.  * software and its documentation for any purpose and without
  16.  * fee is hereby granted, provided that the above copyright
  17.  * notice appear in all copies.  The University of California
  18.  * makes no representations about the suitability of this
  19.  * software for any purpose.  It is provided "as is" without
  20.  * express or implied warranty.
  21.  *
  22.  * $Header: /cdrom/src/kernel/Cvsroot/kernel/lfs/lfsSuperBlock.h,v 1.6 91/12/17 17:33:52 jhh Exp $ SPRITE (Berkeley)
  23.  */
  24.  
  25. #ifndef _LFSSUPERBLOCK
  26. #define _LFSSUPERBLOCK
  27.  
  28. #ifdef EKERNEL
  29. #include <lfsDescMap.h>
  30. #include <lfsUsageArray.h>
  31. #include <lfsFileLayout.h>
  32. #else
  33. #include <kernel/lfsDescMap.h>
  34. #include <kernel/lfsUsageArray.h>
  35. #include <kernel/lfsFileLayout.h>
  36. #endif
  37. /*
  38.  * The LfsSuperBlockHdr contains static parameters describing the file system
  39.  * layout on disk. 
  40.  */
  41. #define    LFS_SUPER_BLOCK_HDR_SIZE    128
  42. typedef struct LfsSuperBlockHdr {
  43.     unsigned int magic;        /* Better be LFS_SUPER_BLOCK_MAGIC. */
  44.     unsigned int version;      /* Version number describing the format used
  45.                  * for this LFS.  */
  46.     int blockSize;        /* The block size of this file system. Should
  47.                  * be set to the minumum addressable unit. */
  48.     /*
  49.      * File system layout. 
  50.      */
  51.     int maxCheckPointBlocks;  /* Maximum size of checkpoint region in blocks. */
  52.     int checkPointOffset[2];/* The block offset into the device of the
  53.                  * two checkpoint areas. Two areas are
  54.                  * used so we never update in place. The
  55.                  * format the segment is defined below. */
  56.     int logStartOffset;     /* The block offset starting the segmented log. */
  57.     int     checkpointInterval;    /* Frequency of checkpoint in seconds. */
  58.     int  maxNumCacheBlocks;     /* Maximum number of blocks to clean at time.*/
  59.     int     domainUID;        /* Unique ID for file system. */
  60.     int     partition;        /* Partition number file system was built in. */
  61.     char reserved[LFS_SUPER_BLOCK_HDR_SIZE-11*sizeof(int)];
  62.                 /* Reserved, must be set to zero. */
  63.  
  64. } LfsSuperBlockHdr;
  65.  
  66. #define    LFS_SUPER_BLOCK_MAGIC        0x106d15c     /* LogDisc */
  67. #define    LFS_SUPER_BLOCK_VERSION        1
  68. #define    LFS_SUPER_BLOCK_SIZE        512
  69. #define LFS_SUPER_BLOCK_OFFSET        64
  70. /*
  71.  * The format a LFS super block. 
  72.  */
  73. typedef struct LfsSuperBlock {
  74.     LfsSuperBlockHdr  hdr;    /* Header describing the layout of the LFS. */
  75.     int        reserved;    /* Reseved field must be zero. */
  76.     LfsDescMapParams  descMap;    /* Descriptor map parameters. */
  77.     LfsSegUsageParams usageArray; /* The segment usage map parameters. */
  78.     LfsFileLayoutParams fileLayout; /* Parameters describing file layout. */
  79.     char padding[LFS_SUPER_BLOCK_SIZE-sizeof(LfsFileLayoutParams) - 
  80.          sizeof(LfsSegUsageParams)-sizeof(LfsDescMapParams) -
  81.          sizeof(int) - sizeof(LfsSuperBlockHdr)];    
  82. } LfsSuperBlock;
  83.  
  84.  
  85. /*
  86.  * Format of the LFS checkpoint areas.  The checkpoint area consists of
  87.  * a LfsCheckPointHdr structure followed by zero or more LfsCheckPointRegion
  88.  * from each module.  The last LfsCheckPointRegion is ended with a 
  89.  * LfsCheckPointTrailer.
  90.  */
  91.  
  92. typedef struct LfsCheckPointHdr {
  93.     unsigned int timestamp;    /* Timestamp of this checkpoint. */
  94.     int size;            /* Size of checkpoint in bytes. */
  95.     unsigned int version;    /* Region write version number. */
  96.     char domainPrefix[64];    /* Last prefix used for the domain */
  97.     int     domainNumber;        /* Last domain we ran under. */
  98.     int     attachSeconds;        /* Time the disk was attached */
  99.     int     detachSeconds;        /* Time the disk was off-lined. */
  100.     int     serverID;        /* Sprite ID of server. */
  101. } LfsCheckPointHdr;
  102.  
  103. typedef struct LfsCheckPointRegion {
  104.     unsigned int type;        /* Region type -- see log writing types in
  105.                  * lfsLogFormat.h. */
  106.     int size;            /* Size of the region in bytes. */
  107. } LfsCheckPointRegion;
  108.  
  109. typedef struct LfsCheckPointTrailer {
  110.     unsigned int timestamp;    /* Timestamp of this checkpoint. Must match
  111.                  * the checkpoint on header. */
  112.     unsigned int checkSum;    /* A checksum of the checkpoint check used to
  113.                  * detect partial checkpoint writes. */
  114. } LfsCheckPointTrailer;
  115.  
  116.  
  117. #define    LFS_SUPER_BLOCK_SIZE_OK() \
  118.     ((sizeof(LfsSuperBlock) == LFS_SUPER_BLOCK_SIZE) &&        \
  119.      (sizeof(LfsSuperBlockHdr) == LFS_SUPER_BLOCK_HDR_SIZE) &&    \
  120.      (sizeof(LfsDescMapParams) == LFS_DESC_MAP_PARAM_SIZE) &&    \
  121.      (sizeof(LfsSegUsageParams) == LFS_USAGE_ARRAY_PARAM_SIZE) &&   \
  122.      (sizeof(LfsFileLayoutParams) == LFS_FILE_LAYOUT_PARAMS_SIZE))
  123.  
  124. #endif /* _LFSSUPERBLOCK */
  125.